<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: foe.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('foe_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">foe.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="foe_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  $Id: foe.h,v 6d9865c37b6f 2013/02/12 16:15:09 fp $</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *  This file is part of the IgH EtherCAT Master.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  modify it under the terms of the GNU General Public License version 2, as</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *  Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *  with the IgH EtherCAT Master; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *  ---</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *  The license mentioned above concerns the source code only. Using the</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *  EtherCAT technology and brand is only permitted in compliance with the</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> *  industrial property and similar rights of Beckhoff Automation GmbH.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#ifndef __FOE_H__</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#define __FOE_H__</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659">   41</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aacad8c11589f51ab29e655b3e1f1b636">   42</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aacad8c11589f51ab29e655b3e1f1b636">FOE_BUSY</a>               = 0, </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659af6ef86c554beba5260555602f7aa783d">   43</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659af6ef86c554beba5260555602f7aa783d">FOE_READY</a>              = 1, </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a3ebc15a7b225189ffc6b8545574f7868">   44</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a3ebc15a7b225189ffc6b8545574f7868">FOE_IDLE</a>               = 2, </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a43ef98e38a295df885d2276078a92bae">   45</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a43ef98e38a295df885d2276078a92bae">FOE_WC_ERROR</a>           = 3, </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a622fc9421868423ac34832850e8ea7e1">   46</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a622fc9421868423ac34832850e8ea7e1">FOE_RECEIVE_ERROR</a>      = 4, </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659adca69ad8fe0509935b2b73550c8396cc">   47</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659adca69ad8fe0509935b2b73550c8396cc">FOE_PROT_ERROR</a>         = 5, </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a92cfaf513f401687840e135c583bff70">   48</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a92cfaf513f401687840e135c583bff70">FOE_NODATA_ERROR</a>       = 6, </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a705685af4df10e2c35bc2aa51f33f6e2">   49</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a705685af4df10e2c35bc2aa51f33f6e2">FOE_PACKETNO_ERROR</a>     = 7, </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a68ef05dbc34f0a242d4c1850776a331a">   50</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a68ef05dbc34f0a242d4c1850776a331a">FOE_OPCODE_ERROR</a>       = 8, </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aafb61e94e694f92fb200976a5c8545d9">   51</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aafb61e94e694f92fb200976a5c8545d9">FOE_TIMEOUT_ERROR</a>      = 9, </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a7e4d06a6136f1233195d7513913396ed">   52</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a7e4d06a6136f1233195d7513913396ed">FOE_SEND_RX_DATA_ERROR</a> = 10, </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4232c0480c23c085cdb159b7f1463d1e">   53</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4232c0480c23c085cdb159b7f1463d1e">FOE_RX_DATA_ACK_ERROR</a>  = 11, </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a9b953b8276c951de27df080f5b2b9751">   54</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a9b953b8276c951de27df080f5b2b9751">FOE_ACK_ERROR</a>          = 12, </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659ac76f35a7c145a9178217692e87f64811">   55</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659ac76f35a7c145a9178217692e87f64811">FOE_MBOX_FETCH_ERROR</a>   = 13, </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4dc0872a7ce485c75a74fc161b5080cd">   56</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4dc0872a7ce485c75a74fc161b5080cd">FOE_READ_NODATA_ERROR</a>  = 14, </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a5bceb1cbe5096a97510b5f4f66121908">   57</a></span>&#160;    <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a5bceb1cbe5096a97510b5f4f66121908">FOE_MBOX_PROT_ERROR</a>    = 15, </div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;} <a class="code" href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659">ec_foe_error_t</a>;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a622fc9421868423ac34832850e8ea7e1"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a622fc9421868423ac34832850e8ea7e1">FOE_RECEIVE_ERROR</a></div><div class="ttdoc">Receive error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00046">foe.h:46</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659ac76f35a7c145a9178217692e87f64811"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659ac76f35a7c145a9178217692e87f64811">FOE_MBOX_FETCH_ERROR</a></div><div class="ttdoc">Error fetching data from mailbox. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00055">foe.h:55</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a43ef98e38a295df885d2276078a92bae"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a43ef98e38a295df885d2276078a92bae">FOE_WC_ERROR</a></div><div class="ttdoc">Working counter error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00045">foe.h:45</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a92cfaf513f401687840e135c583bff70"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a92cfaf513f401687840e135c583bff70">FOE_NODATA_ERROR</a></div><div class="ttdoc">No data error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00048">foe.h:48</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a705685af4df10e2c35bc2aa51f33f6e2"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a705685af4df10e2c35bc2aa51f33f6e2">FOE_PACKETNO_ERROR</a></div><div class="ttdoc">Packet number error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00049">foe.h:49</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a68ef05dbc34f0a242d4c1850776a331a"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a68ef05dbc34f0a242d4c1850776a331a">FOE_OPCODE_ERROR</a></div><div class="ttdoc">OpCode error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00050">foe.h:50</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659">ec_foe_error_t</a></div><div class="ttdeci">ec_foe_error_t</div><div class="ttdoc">FoE error enumeration type. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00041">foe.h:41</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a4232c0480c23c085cdb159b7f1463d1e"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4232c0480c23c085cdb159b7f1463d1e">FOE_RX_DATA_ACK_ERROR</a></div><div class="ttdoc">Error acknowledging received data. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00053">foe.h:53</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659aacad8c11589f51ab29e655b3e1f1b636"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aacad8c11589f51ab29e655b3e1f1b636">FOE_BUSY</a></div><div class="ttdoc">Busy. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00042">foe.h:42</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659aafb61e94e694f92fb200976a5c8545d9"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659aafb61e94e694f92fb200976a5c8545d9">FOE_TIMEOUT_ERROR</a></div><div class="ttdoc">Timeout error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00051">foe.h:51</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a3ebc15a7b225189ffc6b8545574f7868"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a3ebc15a7b225189ffc6b8545574f7868">FOE_IDLE</a></div><div class="ttdoc">Idle. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00044">foe.h:44</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659adca69ad8fe0509935b2b73550c8396cc"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659adca69ad8fe0509935b2b73550c8396cc">FOE_PROT_ERROR</a></div><div class="ttdoc">Protocol error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00047">foe.h:47</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659af6ef86c554beba5260555602f7aa783d"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659af6ef86c554beba5260555602f7aa783d">FOE_READY</a></div><div class="ttdoc">Ready. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00043">foe.h:43</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a7e4d06a6136f1233195d7513913396ed"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a7e4d06a6136f1233195d7513913396ed">FOE_SEND_RX_DATA_ERROR</a></div><div class="ttdoc">Error sending received data. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00052">foe.h:52</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a5bceb1cbe5096a97510b5f4f66121908"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a5bceb1cbe5096a97510b5f4f66121908">FOE_MBOX_PROT_ERROR</a></div><div class="ttdoc">Mailbox protocol error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00057">foe.h:57</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a9b953b8276c951de27df080f5b2b9751"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a9b953b8276c951de27df080f5b2b9751">FOE_ACK_ERROR</a></div><div class="ttdoc">Acknowledge error. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00054">foe.h:54</a></div></div>
<div class="ttc" id="foe_8h_html_a1a3752c2c35892afeaf65cac5615c659a4dc0872a7ce485c75a74fc161b5080cd"><div class="ttname"><a href="foe_8h.html#a1a3752c2c35892afeaf65cac5615c659a4dc0872a7ce485c75a74fc161b5080cd">FOE_READ_NODATA_ERROR</a></div><div class="ttdoc">No data while reading. </div><div class="ttdef"><b>Definition:</b> <a href="foe_8h_source.html#l00056">foe.h:56</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="foe_8h.html">foe.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
